/**
 * Copyright 2006 gworks.com.au
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License. (http://www.apache.org/licenses/LICENSE-2.0)
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed 
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for 
 * the specific language governing permissions and limitations under the License.
 *
 * <dhamma-message src="Atisha (11th century Tibetan Buddhist master)">
 * 	The greatest achievement is selflessness. The greatest worth is self-mastery.
 * 	The greatest quality is seeking to serve others. The greatest precept is continual awareness.
 * 	The greatest medicine is the emptiness of everything. The greatest action is not conforming with the worlds ways.
 * 	The greatest magic is transmuting the passions. The greatest generosity is non-attachment.
 * 	The greatest goodness is a peaceful mind. The greatest patience is humility.
 * 	The greatest effort is not concerned with results. The greatest meditation is a mind that lets go.
 * 	The greatest wisdom is seeing through appearances. 
 * </dhamma-message>
 */
package org.javaongems.server.rpc.io;

import java.util.HashMap;
import java.util.Map;

import javax.servlet.http.HttpSession;

import org.apache.commons.fileupload.FileItem;
import org.javaongems.client.service.HttpPostRpc;

/**
 * <p>Provides a model of the payload that has been submitted by the client</p>
 * <p>Responsibilties:
 * <ul>
 * 	<li> store the playload that was posted by the client
 * 	<li> store the progress status of processing the payload
 * 	<li> support helpers to co-ordinate access b/n different threads
 *  <li> support some user-definable cargo required by gem developers
 * </ul>
 * </p> 
 * 
 * @author Ashin Wimalajeewa (ash)
 */
public class HttpPostPayload {
	final public boolean wasMulipart; 
	public Map<String, Object>  cargo = new HashMap<String, Object>();
	public FileItem[]			formFiles;
	public Map<String, String>	formData = new HashMap<String, String>();
	public HttpPostRpc.ProgressInfo progress = new HttpPostRpc.ProgressInfo();
	
	public HttpPostPayload(boolean multipart) {
		wasMulipart = multipart;
	}

	static public String toGemOrderKey(String gemId, String orderNo) {
		String ret = "gems-upload:" + gemId.hashCode() + ":" + orderNo.hashCode();
		return ret;
	}
	
	public void addToSession(String gemId, String orderNo, HttpSession session) {
		String key = toGemOrderKey(gemId, orderNo);
		session.setAttribute(key, this);
	}
	
	static public HttpPostPayload getFromSession(HttpSession session, String gemId, String orderNo) {
		String key = HttpPostPayload.toGemOrderKey(gemId, orderNo);
		HttpPostPayload ret = (HttpPostPayload) session.getAttribute(key);
		return ret;
	}

	static public HttpPostPayload removeFromSession(HttpSession session, String gemId, String orderNo) {
		String key = HttpPostPayload.toGemOrderKey(gemId, orderNo);
		HttpPostPayload ret = (HttpPostPayload) session.getAttribute(key);
		if (ret != null)
			session.removeAttribute(key);
		return ret;
	}

	static public HttpPostPayload getAndRemoveFromSession(HttpSession session, String gemId, String orderNo) {
		String key = HttpPostPayload.toGemOrderKey(gemId, orderNo);
		HttpPostPayload ret = (HttpPostPayload) session.getAttribute(key);
		if (ret != null)
			session.removeAttribute(key);
		return ret;
	}
}